

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>routines Package &mdash; open-ihm v1.0 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '1.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="top" title="open-ihm v1.0 documentation" href="index.html" />
    <link rel="up" title="outputs Package" href="outputs.html" />
    <link rel="next" title="tests Package" href="tests.html" />
    <link rel="prev" title="outputs Package" href="outputs.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="tests.html" title="tests Package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="outputs.html" title="outputs Package"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">open-ihm v1.0 documentation</a> &raquo;</li>
          <li><a href="outputs.html" accesskey="U">outputs Package</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="routines-package">
<h1>routines Package<a class="headerlink" href="#routines-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="id1">
<h2><tt class="xref py py-mod docutils literal"><span class="pre">routines</span></tt> Package<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
<span class="target" id="module-outputs.routines"></span><p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
</div>
<div class="section" id="module-outputs.routines.generate_data_entry_sheet">
<span id="generate-data-entry-sheet-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">generate_data_entry_sheet</span></tt> Module<a class="headerlink" href="#module-outputs.routines.generate_data_entry_sheet" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.generate_data_entry_sheet.DataEntrySheets">
<em class="property">class </em><tt class="descclassname">outputs.routines.generate_data_entry_sheet.</tt><tt class="descname">DataEntrySheets</tt><big>(</big><em>projectid</em><big>)</big><a class="headerlink" href="#outputs.routines.generate_data_entry_sheet.DataEntrySheets" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.generate_data_entry_sheet.DataEntrySheets.buildQueries">
<tt class="descname">buildQueries</tt><big>(</big><em>incometype</em><big>)</big><a class="headerlink" href="#outputs.routines.generate_data_entry_sheet.DataEntrySheets.buildQueries" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.generate_data_entry_sheet.DataEntrySheets.getHouseholdCharacteristics">
<tt class="descname">getHouseholdCharacteristics</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.generate_data_entry_sheet.DataEntrySheets.getHouseholdCharacteristics" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.generate_data_entry_sheet.DataEntrySheets.getPersonalCharacteristics">
<tt class="descname">getPersonalCharacteristics</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.generate_data_entry_sheet.DataEntrySheets.getPersonalCharacteristics" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.generate_data_entry_sheet.DataEntrySheets.getincomeSources">
<tt class="descname">getincomeSources</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.generate_data_entry_sheet.DataEntrySheets.getincomeSources" title="Permalink to this definition">¶</a></dt>
<dd><p>run various select queries</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.generate_data_entry_sheet.DataEntrySheets.populateIncomeSourcesSheet">
<tt class="descname">populateIncomeSourcesSheet</tt><big>(</big><em>book</em>, <em>style2</em><big>)</big><a class="headerlink" href="#outputs.routines.generate_data_entry_sheet.DataEntrySheets.populateIncomeSourcesSheet" title="Permalink to this definition">¶</a></dt>
<dd><p>Populate Sheet 3 with income sources for a selected project</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.generate_data_entry_sheet.DataEntrySheets.writeDataSheets">
<tt class="descname">writeDataSheets</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.generate_data_entry_sheet.DataEntrySheets.writeDataSheets" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_adultequivalent">
<span id="report-adultequivalent-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_adultequivalent</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_adultequivalent" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_adultequivalent.</tt><tt class="descname">AdultEquivalent</tt><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.adjustMemberEnergyReq">
<tt class="descname">adjustMemberEnergyReq</tt><big>(</big><em>energyreq</em>, <em>periodaway</em><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.adjustMemberEnergyReq" title="Permalink to this definition">¶</a></dt>
<dd><p>Adjust member&#8217;s yearly energy requirement according to absence from household</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.caclulateHouseholdAE">
<tt class="descname">caclulateHouseholdAE</tt><big>(</big><em>householdenergyreq</em><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.caclulateHouseholdAE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.calculateAdultEnergyEquivalent">
<tt class="descname">calculateAdultEnergyEquivalent</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.calculateAdultEnergyEquivalent" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate avarage daily food need for adults</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.calculateEnergyReqByAgeSex">
<tt class="descname">calculateEnergyReqByAgeSex</tt><big>(</big><em>age</em>, <em>gender</em><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.calculateEnergyReqByAgeSex" title="Permalink to this definition">¶</a></dt>
<dd><p>Return energy requirement by age and sex</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.calculateHouseholdEnergyReq">
<tt class="descname">calculateHouseholdEnergyReq</tt><big>(</big><em>hid</em>, <em>pid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.calculateHouseholdEnergyReq" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate a household&#8217;s energy requirements by age and sex, for the current year</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.executeQuery">
<tt class="descname">executeQuery</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.executeQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>Execute queries under adult equivalent calculations</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.getEnergyReqAdultFemale">
<tt class="descname">getEnergyReqAdultFemale</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.getEnergyReqAdultFemale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.getEnergyReqAdultMale">
<tt class="descname">getEnergyReqAdultMale</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.getEnergyReqAdultMale" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_adultequivalent.AdultEquivalent.getHouseholdMembers">
<tt class="descname">getHouseholdMembers</tt><big>(</big><em>hhid</em>, <em>pid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_adultequivalent.AdultEquivalent.getHouseholdMembers" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_disposable_income">
<span id="report-disposable-income-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_disposable_income</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_disposable_income" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_disposable_income.</tt><tt class="descname">DisposableHouseholdIncome</tt><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildFinalIncomeCategoryQuery">
<tt class="descname">buildFinalIncomeCategoryQuery</tt><big>(</big><em>query</em>, <em>projectid</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildFinalIncomeCategoryQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>build a final query for getting total household incomes</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildHCharacteristicsQuery">
<tt class="descname">buildHCharacteristicsQuery</tt><big>(</big><em>hcharacteristics</em>, <em>tablename</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildHCharacteristicsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>build query for selecting households that meet selected household characteristics from the report interface</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildHouseholdsQuery">
<tt class="descname">buildHouseholdsQuery</tt><big>(</big><em>selectedhouseholds</em>, <em>projectid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildHouseholdsQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildPCharacteristicsQuery">
<tt class="descname">buildPCharacteristicsQuery</tt><big>(</big><em>pcharacteristics</em>, <em>tablename</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildPCharacteristicsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>build query for selecting households that meet selected personal characteristics from the report interface</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildReportHouseholdIDsQuery">
<tt class="descname">buildReportHouseholdIDsQuery</tt><big>(</big><em>projectid</em>, <em>selectedhouseholds</em>, <em>pcharselected</em>, <em>hcharselected</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.buildReportHouseholdIDsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>generate report household ids</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.calculateHouseholdCashIncome">
<tt class="descname">calculateHouseholdCashIncome</tt><big>(</big><em>reporttype</em>, <em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.calculateHouseholdCashIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate total cash income for selected households</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.calculateHouseholdFoodIncome">
<tt class="descname">calculateHouseholdFoodIncome</tt><big>(</big><em>reporttype</em>, <em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.calculateHouseholdFoodIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate total food income for selected households</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.calculateHouseholdFoodPrice">
<tt class="descname">calculateHouseholdFoodPrice</tt><big>(</big><em>housefoodNeed</em>, <em>pid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.calculateHouseholdFoodPrice" title="Permalink to this definition">¶</a></dt>
<dd><p>calculate the cost of food a houshold has to buy, to meet household food energy needs</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.checkHouseholdFoodNeeds">
<tt class="descname">checkHouseholdFoodNeeds</tt><big>(</big><em>householdsAE</em>, <em>householdsFood</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.checkHouseholdFoodNeeds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.executeQuery">
<tt class="descname">executeQuery</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.executeQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>run various select queries</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getCropCashIncome">
<tt class="descname">getCropCashIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getCropCashIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold crop cash income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getCropFIncome">
<tt class="descname">getCropFIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getCropFIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold crop food income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getEmploymentCashIncome">
<tt class="descname">getEmploymentCashIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getEmploymentCashIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold employment cash income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getEmploymentFIncome">
<tt class="descname">getEmploymentFIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getEmploymentFIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold employment food income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getHouseAE">
<tt class="descname">getHouseAE</tt><big>(</big><em>houseEnergyNeed</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getHouseAE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getHouseholdEnergyNeeds">
<tt class="descname">getHouseholdEnergyNeeds</tt><big>(</big><em>householdids</em>, <em>pid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getHouseholdEnergyNeeds" title="Permalink to this definition">¶</a></dt>
<dd><p>get household food energy needs</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getLivestockCashIncome">
<tt class="descname">getLivestockCashIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getLivestockCashIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold livestock cash income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getLivestockFIncome">
<tt class="descname">getLivestockFIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getLivestockFIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold livestock food income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getReportHouseholdIDs">
<tt class="descname">getReportHouseholdIDs</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getReportHouseholdIDs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getTransferCashIncome">
<tt class="descname">getTransferCashIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getTransferCashIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold transfer cash income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getTransferFIncome">
<tt class="descname">getTransferFIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getTransferFIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold transfer food income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getWildFoodCashIncome">
<tt class="descname">getWildFoodCashIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getWildFoodCashIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold wildfood cash income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.getWildFoodFIncome">
<tt class="descname">getWildFoodFIncome</tt><big>(</big><em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.getWildFoodFIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>get total houshold food income from wildfoods</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.householdDisposableIncome">
<tt class="descname">householdDisposableIncome</tt><big>(</big><em>reporttype</em>, <em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.householdDisposableIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate household disposable income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalCropCashIncomeQuery">
<tt class="descname">totalCropCashIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalCropCashIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalCropFIncomeQuery">
<tt class="descname">totalCropFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalCropFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalEmploymentCashIncomeQuery">
<tt class="descname">totalEmploymentCashIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalEmploymentCashIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalEmploymentFIncomeQuery">
<tt class="descname">totalEmploymentFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalEmploymentFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalLivestockCashIncomeQuery">
<tt class="descname">totalLivestockCashIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalLivestockCashIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalLivestockFIncomeQuery">
<tt class="descname">totalLivestockFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalLivestockFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalTransferCashIncomeQuery">
<tt class="descname">totalTransferCashIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalTransferCashIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalTransferFIncomeQuery">
<tt class="descname">totalTransferFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalTransferFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalWildFoodCashIncomeQuery">
<tt class="descname">totalWildFoodCashIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalWildFoodCashIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalWildFoodFIncomeQuery">
<tt class="descname">totalWildFoodFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposable_income.DisposableHouseholdIncome.totalWildFoodFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_disposableincome_write">
<span id="report-disposableincome-write-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_disposableincome_write</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_disposableincome_write" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_disposableincome_write.HouseholdsIncomeWrite">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_disposableincome_write.</tt><tt class="descname">HouseholdsIncomeWrite</tt><a class="headerlink" href="#outputs.routines.report_disposableincome_write.HouseholdsIncomeWrite" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_disposableincome_write.HouseholdsIncomeWrite.writeSpreadsheetReport">
<tt class="descname">writeSpreadsheetReport</tt><big>(</big><em>reporttable</em>, <em>reporttype</em><big>)</big><a class="headerlink" href="#outputs.routines.report_disposableincome_write.HouseholdsIncomeWrite.writeSpreadsheetReport" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_householdbudget">
<span id="report-householdbudget-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_householdbudget</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_householdbudget" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_householdbudget.</tt><tt class="descname">HouseholdBudget</tt><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.calculateHouseholdFoodPrice">
<tt class="descname">calculateHouseholdFoodPrice</tt><big>(</big><em>housefoodNeed</em>, <em>projectid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.calculateHouseholdFoodPrice" title="Permalink to this definition">¶</a></dt>
<dd><p>calculate the cost of food a houshold has to buy, to meet household food energy needs</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.checkHouseholdFoodNeeds">
<tt class="descname">checkHouseholdFoodNeeds</tt><big>(</big><em>householdsAE</em>, <em>householdsFood</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.checkHouseholdFoodNeeds" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.executeQuery">
<tt class="descname">executeQuery</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.executeQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>run various select queries</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.getAssets">
<tt class="descname">getAssets</tt><big>(</big><em>projectid</em>, <em>selectedHouseholds</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.getAssets" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.getCashIncome">
<tt class="descname">getCashIncome</tt><big>(</big><em>projectid</em>, <em>selectedHouseholds</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.getCashIncome" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.getFoodIncome">
<tt class="descname">getFoodIncome</tt><big>(</big><em>projectid</em>, <em>selectedHouseholds</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.getFoodIncome" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.getHouseAE">
<tt class="descname">getHouseAE</tt><big>(</big><em>houseEnergyNeed</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.getHouseAE" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.getHouseholdEnergyNeeds">
<tt class="descname">getHouseholdEnergyNeeds</tt><big>(</big><em>projectid</em>, <em>selectedHouseholds</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.getHouseholdEnergyNeeds" title="Permalink to this definition">¶</a></dt>
<dd><p>get household food energy needs</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.getHouseholdMembership">
<tt class="descname">getHouseholdMembership</tt><big>(</big><em>projectid</em>, <em>selectedHouseholds</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.getHouseholdMembership" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.getnonFoodExepenses">
<tt class="descname">getnonFoodExepenses</tt><big>(</big><em>projectid</em>, <em>hid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.getnonFoodExepenses" title="Permalink to this definition">¶</a></dt>
<dd><p>Get household non-food expenses</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.householdBudgetSummaries">
<tt class="descname">householdBudgetSummaries</tt><big>(</big><em>projectid</em>, <em>selectedHouseholds</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.householdBudgetSummaries" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate household disposable income</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget.HouseholdBudget.householdDisposableIncome">
<tt class="descname">householdDisposableIncome</tt><big>(</big><em>reporttype</em>, <em>projectid</em>, <em>householdIDs</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget.HouseholdBudget.householdDisposableIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate household disposable income</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_householdbudget_write">
<span id="report-householdbudget-write-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_householdbudget_write</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_householdbudget_write" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_householdbudget_write.</tt><tt class="descname">HouseholdBudgetWrite</tt><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.drawBudgetTemplate">
<tt class="descname">drawBudgetTemplate</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.drawBudgetTemplate" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.saveReport">
<tt class="descname">saveReport</tt><big>(</big><em>book</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.saveReport" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeAssetDetails">
<tt class="descname">writeAssetDetails</tt><big>(</big><em>householdAssets</em>, <em>sheetName</em>, <em>sectionrow</em>, <em>style1</em>, <em>style2</em>, <em>style3</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeAssetDetails" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeFinalSummary">
<tt class="descname">writeFinalSummary</tt><big>(</big><em>householdBudgetSummary</em>, <em>sheetName</em>, <em>sectionrow</em>, <em>style1</em>, <em>style2</em>, <em>style3</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeFinalSummary" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeHouseholdIncome">
<tt class="descname">writeHouseholdIncome</tt><big>(</big><em>householdCashIncome</em>, <em>householdFoodIncome</em>, <em>sheetName</em>, <em>sectionrow</em>, <em>style1</em>, <em>style2</em>, <em>style3</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeHouseholdIncome" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeHouseholdMembership">
<tt class="descname">writeHouseholdMembership</tt><big>(</big><em>HouseholdMembership</em>, <em>sheetName</em>, <em>sectionrow</em>, <em>style1</em>, <em>style2</em>, <em>style3</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeHouseholdMembership" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writePageTitleSection">
<tt class="descname">writePageTitleSection</tt><big>(</big><em>sheetName</em>, <em>style1</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writePageTitleSection" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeSpreadsheetReport">
<tt class="descname">writeSpreadsheetReport</tt><big>(</big><em>selectedHouseholds</em>, <em>householdMembership</em>, <em>householdAssets</em>, <em>householdCashIncome</em>, <em>householdFoodIncome</em>, <em>householdBudgetSummary</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdbudget_write.HouseholdBudgetWrite.writeSpreadsheetReport" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_households_by_characteristics">
<span id="report-households-by-characteristics-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_households_by_characteristics</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_households_by_characteristics" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_households_by_characteristics.</tt><tt class="descname">HouseholdsByCharacteristics</tt><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.buildHCharacteristicsQuery">
<tt class="descname">buildHCharacteristicsQuery</tt><big>(</big><em>hcharacteristics</em>, <em>tablename</em><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.buildHCharacteristicsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>build query for selecting households that meet selected household characteristics from the report interface</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.buildPCharacteristicsQuery">
<tt class="descname">buildPCharacteristicsQuery</tt><big>(</big><em>pcharacteristics</em>, <em>tablename</em><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.buildPCharacteristicsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>build query for selecting households that meet selected personal characteristics from the report interface</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getFinalReportTableData">
<tt class="descname">getFinalReportTableData</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getFinalReportTableData" title="Permalink to this definition">¶</a></dt>
<dd><p>get reporttable where user has selected both household and personal characteristics as output criteria</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getHcharacteristicsTable">
<tt class="descname">getHcharacteristicsTable</tt><big>(</big><em>hquery</em><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getHcharacteristicsTable" title="Permalink to this definition">¶</a></dt>
<dd><p>get households where selected household characteristics from the interface are met</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getHouseholdsForReport">
<tt class="descname">getHouseholdsForReport</tt><big>(</big><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getHouseholdsForReport" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getPcharacteristicsTable">
<tt class="descname">getPcharacteristicsTable</tt><big>(</big><em>pquery</em><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getPcharacteristicsTable" title="Permalink to this definition">¶</a></dt>
<dd><p>get households where selected personal characteristics from the interface are met</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getReportTable">
<tt class="descname">getReportTable</tt><big>(</big><em>projectid</em>, <em>pcharselected</em>, <em>hcharselected</em>, <em>pquery</em>, <em>hquery</em><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics.HouseholdsByCharacteristics.getReportTable" title="Permalink to this definition">¶</a></dt>
<dd><p>generate report tables</p>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_households_by_characteristics_write">
<span id="report-households-by-characteristics-write-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_households_by_characteristics_write</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_households_by_characteristics_write" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_households_by_characteristics_write.HouseholdsByCharacteristicsWrite">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_households_by_characteristics_write.</tt><tt class="descname">HouseholdsByCharacteristicsWrite</tt><a class="headerlink" href="#outputs.routines.report_households_by_characteristics_write.HouseholdsByCharacteristicsWrite" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_households_by_characteristics_write.HouseholdsByCharacteristicsWrite.writeSpreadsheetReport">
<tt class="descname">writeSpreadsheetReport</tt><big>(</big><em>reporttable</em><big>)</big><a class="headerlink" href="#outputs.routines.report_households_by_characteristics_write.HouseholdsByCharacteristicsWrite.writeSpreadsheetReport" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_householdsincome">
<span id="report-householdsincome-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_householdsincome</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_householdsincome" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_householdsincome.</tt><tt class="descname">HouseholdIncome</tt><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildCropFIncomeQuery">
<tt class="descname">buildCropFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>cropdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildCropFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildCropIncomeQuery">
<tt class="descname">buildCropIncomeQuery</tt><big>(</big><em>projectid</em>, <em>cropdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildCropIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildEmploymentFIncomeQuery">
<tt class="descname">buildEmploymentFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>employmentdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildEmploymentFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildEmploymentIncomeQuery">
<tt class="descname">buildEmploymentIncomeQuery</tt><big>(</big><em>projectid</em>, <em>employmentdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildEmploymentIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildHCharacteristicsQuery">
<tt class="descname">buildHCharacteristicsQuery</tt><big>(</big><em>hcharacteristics</em>, <em>tablename</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildHCharacteristicsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>build query for selecting households that meet selected household characteristics from the report interface</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildHouseholdsQuery">
<tt class="descname">buildHouseholdsQuery</tt><big>(</big><em>selectedhouseholds</em>, <em>projectid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildHouseholdsQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildLivestockFIncomeQuery">
<tt class="descname">buildLivestockFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>livestockdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildLivestockFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildLivestockIncomeQuery">
<tt class="descname">buildLivestockIncomeQuery</tt><big>(</big><em>projectid</em>, <em>livestockdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildLivestockIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildLoanIncomeQuery">
<tt class="descname">buildLoanIncomeQuery</tt><big>(</big><em>projectid</em>, <em>loandetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildLoanIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildPCharacteristicsQuery">
<tt class="descname">buildPCharacteristicsQuery</tt><big>(</big><em>pcharacteristics</em>, <em>tablename</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildPCharacteristicsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>build query for selecting households that meet selected personal characteristics from the report interface</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildReportHouseholdIDsQuery">
<tt class="descname">buildReportHouseholdIDsQuery</tt><big>(</big><em>projectid</em>, <em>selectedhouseholds</em>, <em>pcharselected</em>, <em>hcharselected</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildReportHouseholdIDsQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>generate report household ids</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildStandardisedCropIncomeQuery">
<tt class="descname">buildStandardisedCropIncomeQuery</tt><big>(</big><em>projectid</em>, <em>cropdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildStandardisedCropIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildTransferFIncomeQuery">
<tt class="descname">buildTransferFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>transferdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildTransferFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildTransferIncomeQuery">
<tt class="descname">buildTransferIncomeQuery</tt><big>(</big><em>projectid</em>, <em>transferdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildTransferIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildWildFoodsFIncomeQuery">
<tt class="descname">buildWildFoodsFIncomeQuery</tt><big>(</big><em>projectid</em>, <em>wildfoodsdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildWildFoodsFIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.buildWildFoodsIncomeQuery">
<tt class="descname">buildWildFoodsIncomeQuery</tt><big>(</big><em>projectid</em>, <em>wildfoodsdetails</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.buildWildFoodsIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.getAdultEquivalent">
<tt class="descname">getAdultEquivalent</tt><big>(</big><em>hhid</em>, <em>pid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.getAdultEquivalent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.getFinalIncomeReportTableQuery">
<tt class="descname">getFinalIncomeReportTableQuery</tt><big>(</big><em>reporttype</em>, <em>projectid</em>, <em>householdIDs</em>, <em>cropdetails</em>, <em>employmentdetails</em>, <em>livestockdetails</em>, <em>loandetails</em>, <em>transferdetails</em>, <em>wildfoodsdetails</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.getFinalIncomeReportTableQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.getHouseholdAdultEquivalent">
<tt class="descname">getHouseholdAdultEquivalent</tt><big>(</big><em>projectid</em>, <em>householdids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.getHouseholdAdultEquivalent" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.getReportHouseholdIDs">
<tt class="descname">getReportHouseholdIDs</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.getReportHouseholdIDs" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.getReportTable">
<tt class="descname">getReportTable</tt><big>(</big><em>query</em>, <em>pid</em>, <em>reporttype</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.getReportTable" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="outputs.routines.report_householdsincome.HouseholdIncome.standardiseIncome">
<tt class="descname">standardiseIncome</tt><big>(</big><em>row</em>, <em>householdAE</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome.HouseholdIncome.standardiseIncome" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_householdsincome_query">
<span id="report-householdsincome-query-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_householdsincome_query</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_householdsincome_query" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_householdsincome_query.HouseholdIncomeQuery">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_householdsincome_query.</tt><tt class="descname">HouseholdIncomeQuery</tt><a class="headerlink" href="#outputs.routines.report_householdsincome_query.HouseholdIncomeQuery" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_householdsincome_query.HouseholdIncomeQuery.buildFinalReportQuery">
<tt class="descname">buildFinalReportQuery</tt><big>(</big><em>projectid</em>, <em>householdIDs</em>, <em>cropsQuery</em>, <em>employmentQuery</em>, <em>livestockQuery</em>, <em>loansQuery</em>, <em>transfersQuery</em>, <em>wildfoodsQuery</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome_query.HouseholdIncomeQuery.buildFinalReportQuery" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_householdsincome_write">
<span id="report-householdsincome-write-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_householdsincome_write</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_householdsincome_write" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_householdsincome_write.HouseholdsIncomeWrite">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_householdsincome_write.</tt><tt class="descname">HouseholdsIncomeWrite</tt><a class="headerlink" href="#outputs.routines.report_householdsincome_write.HouseholdsIncomeWrite" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_householdsincome_write.HouseholdsIncomeWrite.writeSpreadsheetReport">
<tt class="descname">writeSpreadsheetReport</tt><big>(</big><em>reporttable</em>, <em>reporttype</em><big>)</big><a class="headerlink" href="#outputs.routines.report_householdsincome_write.HouseholdsIncomeWrite.writeSpreadsheetReport" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

</div>
<div class="section" id="module-outputs.routines.report_livingthreshold">
<span id="report-livingthreshold-module"></span><h2><tt class="xref py py-mod docutils literal"><span class="pre">report_livingthreshold</span></tt> Module<a class="headerlink" href="#module-outputs.routines.report_livingthreshold" title="Permalink to this headline">¶</a></h2>
<p>This file is part of open-ihm.</p>
<p>open-ihm is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation, either version 3 of the License, or (at your
option) any later version.</p>
<p>open-ihm is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License
along with open-ihm.  If not, see &lt;<a class="reference external" href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.</p>
<dl class="class">
<dt id="outputs.routines.report_livingthreshold.LivingThreshhold">
<em class="property">class </em><tt class="descclassname">outputs.routines.report_livingthreshold.</tt><tt class="descname">LivingThreshhold</tt><a class="headerlink" href="#outputs.routines.report_livingthreshold.LivingThreshhold" title="Permalink to this definition">¶</a></dt>
<dd><dl class="method">
<dt id="outputs.routines.report_livingthreshold.LivingThreshhold.determineLThresholdPosition">
<tt class="descname">determineLThresholdPosition</tt><big>(</big><em>reporttype</em>, <em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_livingthreshold.LivingThreshhold.determineLThresholdPosition" title="Permalink to this definition">¶</a></dt>
<dd><p>Check whether a household is above or below the living threshold for a particular project</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_livingthreshold.LivingThreshhold.executeSelectQuery">
<tt class="descname">executeSelectQuery</tt><big>(</big><em>query</em><big>)</big><a class="headerlink" href="#outputs.routines.report_livingthreshold.LivingThreshhold.executeSelectQuery" title="Permalink to this definition">¶</a></dt>
<dd><p>Run Select Query</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_livingthreshold.LivingThreshhold.getDisposableIncome">
<tt class="descname">getDisposableIncome</tt><big>(</big><em>reporttype</em>, <em>projectid</em>, <em>houseids</em><big>)</big><a class="headerlink" href="#outputs.routines.report_livingthreshold.LivingThreshhold.getDisposableIncome" title="Permalink to this definition">¶</a></dt>
<dd><p>Get Disposable income for selected households</p>
</dd></dl>

<dl class="method">
<dt id="outputs.routines.report_livingthreshold.LivingThreshhold.getHouseholdExpenditure">
<tt class="descname">getHouseholdExpenditure</tt><big>(</big><em>projectid</em>, <em>hhid</em><big>)</big><a class="headerlink" href="#outputs.routines.report_livingthreshold.LivingThreshhold.getHouseholdExpenditure" title="Permalink to this definition">¶</a></dt>
<dd><p>Calculate total household expenditure</p>
</dd></dl>

</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/EfDUnimaChancoCompositeSmall.jpg" alt="Logo"/>
            </a></p>
  <h3><a href="index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">routines Package</a><ul>
<li><a class="reference internal" href="#id1"><tt class="docutils literal"><span class="pre">routines</span></tt> Package</a></li>
<li><a class="reference internal" href="#module-outputs.routines.generate_data_entry_sheet"><tt class="docutils literal"><span class="pre">generate_data_entry_sheet</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_adultequivalent"><tt class="docutils literal"><span class="pre">report_adultequivalent</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_disposable_income"><tt class="docutils literal"><span class="pre">report_disposable_income</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_disposableincome_write"><tt class="docutils literal"><span class="pre">report_disposableincome_write</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_householdbudget"><tt class="docutils literal"><span class="pre">report_householdbudget</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_householdbudget_write"><tt class="docutils literal"><span class="pre">report_householdbudget_write</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_households_by_characteristics"><tt class="docutils literal"><span class="pre">report_households_by_characteristics</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_households_by_characteristics_write"><tt class="docutils literal"><span class="pre">report_households_by_characteristics_write</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_householdsincome"><tt class="docutils literal"><span class="pre">report_householdsincome</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_householdsincome_query"><tt class="docutils literal"><span class="pre">report_householdsincome_query</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_householdsincome_write"><tt class="docutils literal"><span class="pre">report_householdsincome_write</span></tt> Module</a></li>
<li><a class="reference internal" href="#module-outputs.routines.report_livingthreshold"><tt class="docutils literal"><span class="pre">report_livingthreshold</span></tt> Module</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="outputs.html"
                        title="previous chapter">outputs Package</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="tests.html"
                        title="next chapter">tests Package</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/outputs.routines.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="tests.html" title="tests Package"
             >next</a> |</li>
        <li class="right" >
          <a href="outputs.html" title="outputs Package"
             >previous</a> |</li>
        <li><a href="index.html">open-ihm v1.0 documentation</a> &raquo;</li>
          <li><a href="outputs.html" >outputs Package</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2011, University of Malawi, Evidence for Development, University of Wolverhampton.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    </div>
  </body>
</html>